Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update install instructions, for release of sourmash 2.0 #592

Merged
merged 6 commits into from
Mar 22, 2019

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Dec 29, 2018

Once we have a splendiferous sourmash 2.0 release, we need to update install instructions appropriately!

This is currently a merge into #591. This branch should not be merged until we're ready to release sourmash 2.0.

Fixes #592 #425 #159 #521.

TODO:

  • hunt down any other installation docs we need to fix :)
  • remove warning at top of index.rst

  • Is it mergeable?
  • make test Did it pass the tests?
  • make coverage Is the new code covered?
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Was a spellchecker run on the source code and documentation after
    changes were made?

@ctb ctb mentioned this pull request Dec 29, 2018
5 tasks
@luizirber luizirber changed the base branch from update/install_prerelease to master December 29, 2018 20:39
@luizirber
Copy link
Member

Suggestion: during the 'hunting down docs', keep a list (in an issue?) with locations! (So we don't need to hunt them down again)

Also: if we want to point to a specific branch for workshops, let's tag it and install the tag... So instead of

pip install git+https://github.com/dib-lab/sourmash@master

we do

pip install git+https://github.com/dib-lab/sourmash@my-workshop-tag

@ctb
Copy link
Contributor Author

ctb commented Jan 1, 2019 via email

@codecov
Copy link

codecov bot commented Jan 4, 2019

Codecov Report

Merging #592 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #592   +/-   ##
=======================================
  Coverage   89.47%   89.47%           
=======================================
  Files          27       27           
  Lines        4238     4238           
  Branches       39       39           
=======================================
  Hits         3792     3792           
  Misses        446      446

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 38595be...4fb024c. Read the comment docs.

@luizirber luizirber changed the title [WIP] Update install instructions, for release of sourmash 2.0 Update install instructions, for release of sourmash 2.0 Mar 22, 2019
@luizirber luizirber merged commit 7e1f942 into master Mar 22, 2019
@luizirber luizirber deleted the update/install_postrelease branch March 22, 2019 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants